✨ Initial scaffolding for operator #4117

wfernandes · 2021-01-25T18:28:53Z

What this PR does / why we need it:
This PR adds the initial bare bones scaffolding for the CAPI operator.

kubebuilder init --domain operator.cluster.x-k8s.io
# Created Resource and Controller
kubebuilder create api --group operator --version v1alpha4 --kind CoreProvider
# Created Resources and no Controllers for each of the following 
# since we are going to have a single controller reconciler for all the resources.
kubebuilder create api --group operator --version v1alpha4 --kind BootstrapProvider
kubebuilder create api --group operator --version v1alpha4 --kind ControlPlaneProvider
kubebuilder create api --group operator --version v1alpha4 --kind InfrastructureProvider

Other Notes

The API will be incrementally added in.
make commands coming in a separate PR.
Dockerfile updates in a separate PR.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Ref #3833
Fixes #4118

/area api
/area operator

k8s-ci-robot · 2021-01-25T18:28:55Z

@wfernandes: The label(s) area/operator cannot be applied, because the repository doesn't have them

In response to this:

What this PR does / why we need it:
This PR adds the initial bare bones scaffolding for the CAPI operator.
kubebuilder init --domain operator.cluster.x-k8s.io
# Created Resource and Controller
kubebuilder create api --group operator --version v1alpha4 --kind CoreProvider
# Created Resources and no Controllers for each of the following 
# since we are going to have a single controller reconciler for all the resources.
kubebuilder create api --group operator --version v1alpha4 --kind BootstrapProvider
kubebuilder create api --group operator --version v1alpha4 --kind ControlPlaneProvider
kubebuilder create api --group operator --version v1alpha4 --kind InfrastructureProvider
Other Notes

The API will be incrementally added in.

make commands coming in a separate PR.

Dockerfile updates in a separate PR.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Ref #3833

/area api
/area operator

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

wfernandes · 2021-01-25T18:36:52Z

/cc @fabriziopandini @CecileRobertMichon

I know this PR looks enormous but it's just a few kubebuilder commands that generates some initial scaffolding.

I'm trying to break out the work for the operator into smaller PRs with respective issues so that the work isn't too overwhelming.

fabriziopandini

@wfernandes thanks!
I have added a couple of comments, mostly about changes required in order to make the default Kubebuilder scaffolding more consistent/integrated with the rest of the codebase.
Up to you if to tackle this comments within this PR or in follow up PRs.

operator/.gitignore

operator/Dockerfile

operator/Makefile

operator/go.mod

operator/hack/boilerplate.go.txt

operator/main.go

fabriziopandini · 2021-01-28T09:33:38Z

Changes LGTM to me given the assumption this is plain "kubebuilder" scaffholding and #4126 is going to make everything more consistent/integrated with the rest of the codebase (thus addressing above comments).

operator/Dockerfile

wfernandes · 2021-01-29T18:17:08Z

@fabriziopandini @CecileRobertMichon LMK if y'all think other changes are needed in this specific PR.

Just FYI, I have #4126 and #4132 in the queue ready to be rebased and reviewed as well. So there may be suggestions or changes that have already been addressed.

CecileRobertMichon

/lgtm

vincepri · 2021-02-01T18:27:58Z

/hold

alexander-demicev · 2021-02-26T13:07:21Z

I moved the code to exp directory and did a rebase from main. @fabriziopandini @CecileRobertMichon

fabriziopandini · 2021-02-26T14:48:08Z

docs/book/src/tasks/healthcheck.md

@@ -16,15 +16,16 @@ at the bottom of this page for full details of MachineHealthCheck limitations.

 ## What is a MachineHealthCheck?

-A MachineHealthCheck is a resource within the Cluster API which allows users to define conditions under which Machines within a Cluster should be considered unhealthy.
+A MachineHealthCheck is a resource within the Cluster API which allows users to define conditions under which Machines within a Cluster should be considered unhealthy. 


Those changes seems from a commit not relevant for this PR

Yeah, since the operator is in a separate branch, these commits come from a rebase. I can remove them from the PR.

Unnecessary commits removed, all should be fine now.

fabriziopandini · 2021-03-01T21:42:36Z

As per #4117 (review) this PR introduces kubebuilder standard scaffolding, but there are changes to be applied in order to make things more consistent with the CAPI repository.

I'm ok to get these point fixed in follow up PRs, but given that now more people are going to work on this I would like to get them tracked somewhere (one or more new issues, or a comment in existing ones).

For your convenience below the list of things captured in the previous review:

avoid a new go.mod file
avoid a new .gitignore and rely on the top level one (e.g. we are already doing this for KCP, CABPK)
avoid a new docker file and rely on the top level one (e.g. we are already doing this for KCP, CABPK)
avoid a new boilerplate.txt file and use the one under hack/
the make file should be made consistent with other makefiles in CAPI
- drop targets like run and provide a consistent dev UX (tilt)
- drop fmt/vet in favour of golangci for consistency with the rest of the codebase
- use the controller-gen under hack/tools/
- use a consistent build/package (publish) strategy
use a unique name for the certificate secret
target a new namespace (capi-operator-system)
prefix all the object names with capi-operator
add the clusterctl.cluster.x-k8s.io/core="operator" label to all the objects
introduce manager_image_patch.yaml manager_pull_policy.yaml patches (see consistent dev UX)
add the node-role.kubernetes.io/master toleration
make roles consistent with other operators (1 file with all the roles)
drop samples
use cert-manager v1 API (new)
remove Log field from the reconciler (and use the one from the context)
use common names for the flags (e.g. metrics-bind-addr instead of metrics-addr)
switch to klog for consistency with the rest of the codebase
switch from ginkgo to go test

k8s-ci-robot · 2021-03-01T21:42:43Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

alexander-demicev · 2021-03-02T12:36:22Z

@fabriziopandini Thank you for your review and suggestions. Some of your points already might've been addressed in 2 other PRs related to the operator. I do agree this should all be tracked and fixed in follow-up PRs.

Domain is cluster.x-k8s.io Create API scaffolding for CoreProvider kubebuilder create api --group operator --version v1alpha4 --kind CoreProvider Create API scaffolding for BootstrapProvider kubebuilder create api --group operator --version v1alpha4 --kind BootstrapProvider Created Resources, not controllers Create API scaffolding for ControlPlaneProvider kubebuilder create api --group operator --version v1alpha4 --kind ControlPlaneProvider Created Resources, not controllers Create API scaffolding for InfrastructureProvider kubebuilder create api --group operator --version v1alpha4 --kind InfrastructureProvider Created Resources, not controllers Add placeholders for ProviderSpec and ProviderStatus Fix some module imports. Will be cleaned up in future PRs. Fix boilerplate on files Move operator to exp folder

alexander-demicev · 2021-03-03T11:11:12Z

@fabriziopandini CLA check now passes and commits are squashed.

fabriziopandini · 2021-03-03T15:55:39Z

given that future work is tracked in #4246
/lgtm

CecileRobertMichon · 2021-03-03T17:23:26Z

@alexander-demichev this is still a draft PR, are you ready to move it to PR and remove the hold?

alexander-demicev · 2021-03-03T17:36:15Z

it's not a draft PR anymore, should be ready for merging.

CecileRobertMichon · 2021-03-03T19:59:01Z

it's not a draft PR anymore, should be ready for merging.

I still see "draft" at the top under the title, and it still has WIP and hold labels. I don't see an option to publish the PR, maybe only @wfernandes can do it since he's the PR author. If not you might have to open a new PR from the same branch so we can merge it @alexander-demichev.

fabriziopandini · 2021-03-04T09:39:54Z

/hold cancel

alexander-demicev · 2021-03-04T10:43:14Z

@CecileRobertMichon the PR should now be ready for merging.

CecileRobertMichon · 2021-03-04T17:09:20Z

/lgtm
/approve

k8s-ci-robot · 2021-03-04T17:09:28Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CecileRobertMichon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [CecileRobertMichon]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added area/api Issues or PRs related to the APIs cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 25, 2021

k8s-ci-robot requested review from CecileRobertMichon and justinsb January 25, 2021 18:29

k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jan 25, 2021

k8s-ci-robot requested a review from fabriziopandini January 25, 2021 18:36

wfernandes mentioned this pull request Jan 26, 2021

🌱 Add make commands for CAPI operator #4126

Merged

fabriziopandini reviewed Jan 27, 2021

View reviewed changes

CecileRobertMichon reviewed Jan 28, 2021

View reviewed changes

operator/Dockerfile Outdated Show resolved Hide resolved

wfernandes force-pushed the capi-operator-scaffolding branch from 9404d34 to 94f2983 Compare January 29, 2021 16:28

CecileRobertMichon reviewed Jan 29, 2021

View reviewed changes

k8s-ci-robot assigned CecileRobertMichon Jan 29, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 29, 2021

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 1, 2021

wfernandes marked this pull request as draft February 9, 2021 22:50

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 9, 2021

wfernandes changed the base branch from master to operator-0.4 February 23, 2021 18:20

alexander-demicev force-pushed the capi-operator-scaffolding branch from 94f2983 to eae016e Compare February 25, 2021 16:51

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 25, 2021

fabriziopandini reviewed Feb 26, 2021

View reviewed changes

alexander-demicev force-pushed the capi-operator-scaffolding branch from eae016e to 606c913 Compare March 1, 2021 11:33

k8s-ci-robot removed the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 1, 2021

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 1, 2021

wfernandes force-pushed the capi-operator-scaffolding branch from 606c913 to ec84695 Compare March 3, 2021 02:57

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 3, 2021

alexander-demicev force-pushed the capi-operator-scaffolding branch from ec84695 to ced6551 Compare March 3, 2021 11:10

alexander-demicev mentioned this pull request Mar 3, 2021

Make operator consistent with other CAPI parts #4246

Closed

29 tasks

k8s-ci-robot assigned fabriziopandini Mar 3, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 3, 2021

wfernandes marked this pull request as ready for review March 4, 2021 01:46

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 4, 2021

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 4, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 4, 2021

k8s-ci-robot merged commit 48f7531 into kubernetes-sigs:operator-0.4 Mar 4, 2021

alexander-demicev deleted the capi-operator-scaffolding branch March 4, 2021 17:10

alexander-demicev mentioned this pull request Mar 15, 2021

Generate initial scaffolding for the operator #4118

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Initial scaffolding for operator #4117

✨ Initial scaffolding for operator #4117

wfernandes commented Jan 25, 2021 •

edited

Loading

k8s-ci-robot commented Jan 25, 2021

wfernandes commented Jan 25, 2021

fabriziopandini left a comment

fabriziopandini commented Jan 28, 2021 •

edited

Loading

wfernandes commented Jan 29, 2021

CecileRobertMichon left a comment

vincepri commented Feb 1, 2021

alexander-demicev commented Feb 26, 2021

fabriziopandini Feb 26, 2021

alexander-demicev Feb 26, 2021

alexander-demicev Mar 1, 2021 •

edited

Loading

fabriziopandini commented Mar 1, 2021

k8s-ci-robot commented Mar 1, 2021

alexander-demicev commented Mar 2, 2021

alexander-demicev commented Mar 3, 2021

fabriziopandini commented Mar 3, 2021

CecileRobertMichon commented Mar 3, 2021

alexander-demicev commented Mar 3, 2021

CecileRobertMichon commented Mar 3, 2021

fabriziopandini commented Mar 4, 2021

alexander-demicev commented Mar 4, 2021

CecileRobertMichon commented Mar 4, 2021

k8s-ci-robot commented Mar 4, 2021

✨ Initial scaffolding for operator #4117

✨ Initial scaffolding for operator #4117

Conversation

wfernandes commented Jan 25, 2021 • edited Loading

k8s-ci-robot commented Jan 25, 2021

wfernandes commented Jan 25, 2021

fabriziopandini left a comment

Choose a reason for hiding this comment

fabriziopandini commented Jan 28, 2021 • edited Loading

wfernandes commented Jan 29, 2021

CecileRobertMichon left a comment

Choose a reason for hiding this comment

vincepri commented Feb 1, 2021

alexander-demicev commented Feb 26, 2021

fabriziopandini Feb 26, 2021

Choose a reason for hiding this comment

alexander-demicev Feb 26, 2021

Choose a reason for hiding this comment

alexander-demicev Mar 1, 2021 • edited Loading

Choose a reason for hiding this comment

fabriziopandini commented Mar 1, 2021

k8s-ci-robot commented Mar 1, 2021

alexander-demicev commented Mar 2, 2021

alexander-demicev commented Mar 3, 2021

fabriziopandini commented Mar 3, 2021

CecileRobertMichon commented Mar 3, 2021

alexander-demicev commented Mar 3, 2021

CecileRobertMichon commented Mar 3, 2021

fabriziopandini commented Mar 4, 2021

alexander-demicev commented Mar 4, 2021

CecileRobertMichon commented Mar 4, 2021

k8s-ci-robot commented Mar 4, 2021

wfernandes commented Jan 25, 2021 •

edited

Loading

fabriziopandini commented Jan 28, 2021 •

edited

Loading

alexander-demicev Mar 1, 2021 •

edited

Loading